Esx Settings SoftwareSpec
The Esx Settings SoftwareSpec schema contains properties that describe desired software specification for an ESX host.
This schema was added in vSphere API 7.0.0.0.
{
"base_image": {
"version": "string"
},
"add_on": {
"name": "string",
"version": "string"
},
"components": {
"components": "string"
},
"solutions": {
"solutions": {
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": [
"string"
],
"alternative_images": {
"alternative_images": {
"base_image": {
"version": "string"
},
"add_on": {
"name": "string",
"version": "string"
},
"components": {
"components": "string"
},
"solutions": {
"solutions": {
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": [
"string"
],
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}
}
}Base image of the ESX.
This property was added in vSphere API 7.0.0.0.
OEM customization on top of given base-image. The components in this customization override the components in the base base-image.
This property was added in vSphere API 7.0.0.0.
If missing or null, no OEM customization will be applied.
Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in Esx Settings SoftwareSpec.add_on and Esx Settings SoftwareSpec.base_image.
This property was added in vSphere API 7.0.0.0.
If missing or null, no additional components will be installed.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.
Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution.
This property was added in vSphere API 7.0.0.0.
If missing or null, no solutions will be part of the software specification.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.solution.
Information about the Hardware Support Package (HSP) configured in the software specification.
This property was added in vSphere API 7.0.0.0.
If missing or null or empty, no firmware compliance checking or remediation will be done.
Components to be removed from the software specification.
This property was added in vSphere API 8.0.3.0.
If missing or null no component will be removed.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.component.
Alternative Images apart from the Default Image
This property was added in vSphere API 9.0.0.0.
If missing or null, no alternative image will be part of the software specification. Image ID supports only the following ASCII characters [a-z][A-Z][0-9][-] Case will be ignored when comparing identifiers "IMAGE-1" is equal to "image-1"
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.image. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.image.